/**
 * Copyright (C) 2013 DaiKit.com - daikit4gxt module (admin@daikit.com)
 *
 *         Project home : http://code.daikit.com/daikit4gxt
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.daikit.daikit4gxt.client.ui.popup;

import com.daikit.commons.shared.bean.AbstractDkBeanWithId;
import com.daikit.daikit4gxt.client.action.DkBaseAction;
import com.daikit.daikit4gxt.client.action.DkBaseAsyncCallback;
import com.daikit.daikit4gxt.client.editor.DkSimpleBeanEditorDriver;
import com.google.gwt.editor.client.Editor;


/**
 * A callback for {@link DkEditCreatePopup}. This callback must be passed in show method.
 *
 * @author tcaselli
 * @version $Revision$ Last modifier: $Author$ Last commit: $Date$
 * @param <BEANTYPE>
 *           edited bean type
 * @param <STORETYPE>
 *           the type of the bean in store
 * @param <EDITORTYPE>
 *           {@link Editor} type (editor for type B)
 */
public class DkEditCreatePopupCallback<BEANTYPE extends AbstractDkBeanWithId, STORETYPE extends AbstractDkBeanWithId, EDITORTYPE extends Editor<? super BEANTYPE>>
{

	/**
	 * Callback before the {@link DkEditCreatePopup} is shown. (after model has been edited in the editor driver)
	 *
	 * @param editor
	 *           the editor
	 * @param driver
	 *           the editor driver
	 */
	public void onAfterDriverEditBeforeShow(final EDITORTYPE editor, final DkSimpleBeanEditorDriver<BEANTYPE, ? extends Editor<BEANTYPE>> driver)
	{
		// Nothing done by default
	}

	/**
	 * Callback before the model is edited in the editor driver
	 *
	 * @param bean
	 *           the saved model
	 * @param driver
	 *           the editor driver
	 */
	public void onBeforeDriverEdit(final BEANTYPE bean, final DkSimpleBeanEditorDriver<BEANTYPE, ? extends Editor<BEANTYPE>> driver)
	{
		// Nothing done by default
	}

	/**
	 * Callback when model saved before store is updated.
	 *
	 * @param bean
	 *           the saved model. It may be null.
	 * @param isCreation
	 *           boolean indicating whether the callback was called after the bean was saved in a creation process (and
	 *           not an update)
	 */
	public void onAfterSaveBeforeStoreUpdate(final STORETYPE bean, final boolean isCreation)
	{
		// Nothing done by default
	}

	/**
	 * Callback when model saved. This method is not called if the actionResult is null.
	 *
	 * @param bean
	 *           the saved model. It cannot be null.
	 * @param isCreation
	 *           boolean indicating whether the callback was called after the bean was saved in a creation process (and
	 *           not an update)
	 */
	public void onAfterSaveAfterStoreUpdate(final STORETYPE bean, final boolean isCreation)
	{
		// Nothing done by default
	}

	/**
	 * Callback after {@link DkEditCreateProxyPopup#invalidateUi()} method is called.
	 *
	 * @param editor
	 *           the editor
	 */
	public void onAfterInvalidateUi(final EDITORTYPE editor)
	{
		// Nothing done by default
	}

	/**
	 * Allows to override {@link DkEditCreateProxyPopup}.callRetrieveModelForEditionRpc(AbstractDkBeanWithId,
	 * DkBaseAsyncCallback)}
	 *
	 * @param popup
	 *           the popup
	 * @param inputModel
	 * @param callback
	 *           {@link DkBaseAsyncCallback} to be called to continue action chain
	 */
	public void callRetrieveModelForEditionRpc(final DkEditCreateProxyPopup<BEANTYPE, STORETYPE, ? extends EDITORTYPE> popup, final STORETYPE inputModel,
			final DkBaseAsyncCallback<BEANTYPE> callback)
	{
		popup.callRetrieveModelForEditionRpc(inputModel, callback);
	}

	/**
	 * Allows to override {@link DkEditCreateProxyPopup}.callRetrieveModelForCreationRpc(DkBaseAsyncCallback)
	 *
	 * @param popup
	 *           the popup
	 * @param callback
	 *           {@link DkBaseAsyncCallback} to be called to continue action chain
	 */
	public void callRetrieveModelForCreationRpc(final DkEditCreateProxyPopup<BEANTYPE, STORETYPE, ? extends EDITORTYPE> popup,
			final DkBaseAsyncCallback<BEANTYPE> callback)
	{
		popup.callRetrieveModelForCreationRpc(callback);
	}

	/**
	 * Allow to override {@link DkEditCreateProxyPopup}.getConvertResultAction()
	 *
	 * @return null if not needed, an action otherwise.
	 */
	public DkBaseAction<STORETYPE> getConvertResultAction()
	{
		return null;
	}
}
